/*
 * #%L
 * OME-QTWIDGETS C++ library for display of Bio-Formats pixel data and metadata.
 * %%
 * Copyright © 2014 - 2015 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of any organization.
 * #L%
 */

#ifndef OME_QTWIDGETS_GLCONTAINER_H
#define OME_QTWIDGETS_GLCONTAINER_H

#include <QtGui/QWindow>
#include <QtWidgets/QWidget>

namespace ome
{
  namespace qtwidgets
  {

    /**
     * GL window container.
     *
     * A Qt GL window is an entire top-level window.  If this is to be
     * placed in a standard application window, it requires embedding
     * in a widget.  This widget serves to embed a GL window as a
     * regular widget.
     *
     * This may be used to embed any top-level window, not just GL
     * windows.  However, there's rarely any point for non-GL windows
     * since you can just contain their content directly.
     */
    class GLContainer : public QWidget
    {
      Q_OBJECT

    public:
      /**
       * Create a window container.
       *
       * @param parent the parent of this object.
       * @param window the GL window to embed.
       */
      explicit GLContainer(QWidget *parent = 0,
                           QWindow *window = 0);

      /// Destructor.
      ~GLContainer();

      /**
       * Get contained GL window.
       *
       * @returns the GL window.
       */
      QWindow *
      getWindow() const;

      /**
       * Get child GL window container.
       *
       * @returns the container.
       */
      QWidget *
      getContainer() const;

    private:
      /// GL window.
      QWindow *window;
      /// Child containing the GL window.
      QWidget *child;
    };

  }
}

#endif // OME_QTWIDGETS_GLCONTAINER_H

/*
 * Local Variables:
 * mode:C++
 * End:
 */
